|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A content assist subject can request assistance provided by a
content assistant
.
XXX: This is work in progress and can change anytime until API for 3.0 is frozen.
Method Summary | |
void |
addKeyListener(KeyListener keyListener)
Adds the listener to the collection of listeners who will be notified when keys are pressed and released on the system keyboard, by sending it one of the messages defined in the KeyListener interface. |
boolean |
addSelectionListener(SelectionListener selectionListener)
If supported, adds a selection listener. |
boolean |
appendVerifyKeyListener(VerifyKeyListener verifyKeyListener)
If supported, appends a verify key listener to the viewer's list of verify key listeners. |
int |
getCaretOffset()
Returns the caret position relative to the start of the text in widget coordinates. |
Control |
getControl()
Returns the control of this content assist subject. |
IDocument |
getDocument()
Returns this content assist subject's document. |
String |
getLineDelimiter()
Returns the line delimiter used for entering new lines by key down or paste operation. |
int |
getLineHeight()
Returns the line height. |
Point |
getLocationAtOffset(int offset)
Returns the x, y location of the upper left corner of the character bounding box at the specified offset in the text. |
Point |
getSelectedRange()
Returns the selected range. |
Point |
getWidgetSelectionRange()
Returns the selected range in the subject's widget. |
boolean |
prependVerifyKeyListener(VerifyKeyListener verifyKeyListener)
If supported, inserts the verify key listener at the beginning of this content assist subject's list of verify key listeners. |
void |
removeKeyListener(KeyListener keyListener)
Removes the listener from the collection of listeners who will be notified when keys are pressed and released on the system keyboard. |
void |
removeSelectionListener(SelectionListener selectionListener)
Removes the specified selection listener. |
void |
removeVerifyKeyListener(VerifyKeyListener verifyKeyListener)
Removes the verify key listener from this content assist subject's list of verify key listeners. |
void |
revealRange(int offset,
int length)
Reveals the given region. |
void |
setEventConsumer(IEventConsumer eventConsumer)
If supported, registers an event consumer with this content assist subject. |
void |
setSelectedRange(int offset,
int length)
Sets the selected range. |
boolean |
supportsVerifyKeyListener()
Tests whether a verify key listener can be added either using prependVerifyKeyListener
or appendVerifyKeyListener . |
Method Detail |
public Control getControl()
public int getLineHeight()
SWTException
- public int getCaretOffset()
SWTException
- public Point getLocationAtOffset(int offset)
offset
- widget offset relative to the start of the content 0
<= offset <= getCharCount()
SWTException
- IllegalArgumentException
- public String getLineDelimiter()
SWTException
- public Point getWidgetSelectionRange()
SWTException
- public Point getSelectedRange()
public void setSelectedRange(int offset, int length)
offset
- the offset of the selection based on the subject's model
(e.g. document)length
- the length of the selection based on the subject's model
(e.g. document)public void revealRange(int offset, int length)
offset
- the offset of the selection based on the subject's model
(e.g. document)length
- the length of the selection based on the subject's model
(e.g. document)public IDocument getDocument()
public boolean appendVerifyKeyListener(VerifyKeyListener verifyKeyListener)
Note: This content assist subject may not support appending a verify
listener, in which case false
will be returned. If this
content assist subject only supports addVerifyKeyListener
then this method can be used but prependVerifyKeyListener
must return false
.
verifyKeyListener
- the listener to be added
true
if the listener was addedpublic boolean prependVerifyKeyListener(VerifyKeyListener verifyKeyListener)
Note: This content assist subject may not support prepending a verify
listener, in which case false
will be returned. However,
appendVerifyKeyListener
might work.
verifyKeyListener
- the listener to be inserted
true
if the listener was addedpublic void removeVerifyKeyListener(VerifyKeyListener verifyKeyListener)
verifyKeyListener
- the listener to be removedpublic boolean supportsVerifyKeyListener()
prependVerifyKeyListener
or appendVerifyKeyListener
.
true
if adding verify key listeners is supportedpublic void addKeyListener(KeyListener keyListener)
KeyListener
interface.
keyListener
- the listener which should be notified
IllegalArgumentException
- SWTException
- KeyListener
,
removeKeyListener(org.eclipse.swt.events.KeyListener)
public void removeKeyListener(KeyListener keyListener)
keyListener
- the listener which should be notified
IllegalArgumentException
- SWTException
- KeyListener
,
addKeyListener(org.eclipse.swt.events.KeyListener)
public void setEventConsumer(IEventConsumer eventConsumer)
public void removeSelectionListener(SelectionListener selectionListener)
selectionListener
- the listener
SWTException
- IllegalArgumentException
- public boolean addSelectionListener(SelectionListener selectionListener)
selectionListener
- the listener
true
if adding a selection listener is supported
SWTException
- IllegalArgumentException
-
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |